﻿/***************************************************************************
	Copyright (C) 2010 RapidWebDev Organization (Author: Eunge, Legal Name: Jian Liu, Email: eunge.liu@gmail.com)

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ***************************************************************************/

using System;
using System.Data;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Configuration;
using System.Linq;
using System.Text.RegularExpressions;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.HtmlControls;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Xml.Linq;
using BaoJianSoft.Web.Extensions.Controls;

namespace BaoJianSoft.Web.Extensions.DynamicPages
{
	/// <summary>
	/// Excel Field instance.
	/// </summary>
	public sealed class ExcelField
	{
		/// <summary>
		/// Construct Excel Field instance.
		/// </summary>
		/// <param name="fieldName">field name.</param>
		/// <param name="propertyName">mapping property name which the field value will be parsed to.</param>
		public ExcelField(string fieldName, string propertyName)
		{
			this.FieldName = fieldName;
			this.PropertyName = propertyName;
			this.FieldType = ExcelFieldTypes.Text;
		}

		/// <summary>
		/// Get field name.
		/// </summary>
		public string FieldName { get; private set; }

		/// <summary>
		/// Set/get mapping property name which the field value will be parsed to.
		/// </summary>
		public string PropertyName { get; set; }

		/// <summary>
		/// Set/get true if the field is primary key field.
		/// </summary>
		public bool IsPrimaryKey { get; set; }

		/// <summary>
		/// Set/get true if the specified excel field is nullable.
		/// </summary>
		public bool IsNullable { get; set; }

		/// <summary>
		/// Set/get true to display successfully loaded excel field onto grid of the web page. 
		/// The default value is true.
		/// </summary>
		public bool IsDisplayed { get; set; }

		/// <summary>
		/// Set/get displayed format for uploaded field value.
		/// </summary>
		public string DisplayedFormat { get; set; }

		/// <summary>
		/// Set/get excel field type. The default value is ExcelFieldTypes.Text.
		/// </summary>
		public ExcelFieldTypes FieldType { get; set; }

		/// <summary>
		/// Set/get max length of field value for text-typed field.
		/// </summary>
		public int MaxLength { get; set; }

		/// <summary>
		/// Set/get min length of field value for text-typed field.
		/// </summary>
		public int MinLength { get; set; }

		/// <summary>
		/// Set/get max value for double, int, datetime typed field.
		/// </summary>
		public string MaxValue { get; set; }

		/// <summary>
		/// Set/get min value for double, int, datetime typed field.
		/// </summary>
		public string MinValue { get; set; }

		/// <summary>
		/// Set/get regex expression to validate field value.
		/// </summary>
		public Regex Expression { get; set; }

		/// <summary>
		/// Set/get true to callback IExcelDocumentLoader to validate loaded field.
		/// </summary>
		public bool CallbackToValidate { get; set; }

		/// <summary>
		/// Set/get true to callback IExcelDocumentLoader for parsing field value.
		/// </summary>
		public bool CallbackToParseValue { get; set; }
	}
}
